/*
 * Copyright 2015 JBoss, by Red Hat, Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.uberfire.ext.metadata.engine;

import org.uberfire.commons.lifecycle.PriorityDisposable;
import org.uberfire.ext.metadata.model.KCluster;
import org.uberfire.ext.metadata.model.KObject;
import org.uberfire.ext.metadata.model.KObjectKey;

public interface MetaIndexEngine extends PriorityDisposable {

    String FULL_TEXT_FIELD = "fullText";

    boolean freshIndex(final KCluster cluster);

    boolean isIndexReady(final KCluster cluster, final String indexerId);

    void prepareBatch(final KCluster cluster);

    void startBatch(final KCluster cluster);

    void index(final KObject object);

    void rename(final KObjectKey from,
                final KObject to);

    void delete(final KCluster cluster);

    void delete(final KObjectKey objectKey);

    void commit(final KCluster cluster, final String indexerId);

    void abort(final KCluster cluster);

    void beforeDispose(final Runnable callback);

    boolean isAlive();
}
